chore: Have vs code markdownlint extension use config file#4755
chore: Have vs code markdownlint extension use config file#4755thompson-tomo wants to merge 5 commits intoopen-telemetry:mainfrom
Conversation
.vscode/extensions.json
Outdated
| @@ -0,0 +1,5 @@ | |||
| { | |||
| "recommendations": [ | |||
| "davidanson.vscode-markdownlint" | |||
There was a problem hiding this comment.
I like the idea, but looks like this extension is based on markdownlint-cli2, and so flags a lot of things that our existing configuration (based on older version) doesn't
I'd suggest updating the repo to markdownlint-cli2 first and updating configuration to match current repo practices and then come back to this
There was a problem hiding this comment.
I took a look at this and it appears that the first issue is that markdownlint-cli has not been updated.
It is however now pending in the Dashboard #4507
The marketplace listing mentions it supports both. I have also confirmed that is the case. I will submit seperate PR to update rules which will enable update to be merged.
There was a problem hiding this comment.
Pr which applies the latest linting rules is ready as #4756 in that pr when I disabled a rule the violations updated in vs code.
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
## Changes This runs the latest markdownlint-cli and resolves the issues which arises. The dependency update will occur via renovate. This explains @trask feedback in #4755 I have tried to keep changing the style to a minimum hence if all aligned except final column, layout renames as such. For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change). * [ ] Related issues # * [ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) # * [ ] Links to the prototypes (when adding or changing features) * [ ] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes * [ ] [Spec compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix/template.yaml) updated if necessary
|
This PR was marked stale. It will be closed in 14 days without additional activity. |
thompson-tomo
changed the title
thompson-tomo
changed the title
reyang
left a comment
reyang
left a comment
There was a problem hiding this comment.
LGTM. For rewrap, do you want to use Rewrap Revived? @thompson-tomo
+1 . I use Rewrap Revived, and its work well! |
|
So based on https://dnut.github.io/Rewrap/configuration/ rewrap will still work with the current settings proposed here. In relation to adding the rewrap extension, my preference is to only add extensions which the result of that extension is enforced by CI. |
I don't have a strong opinion regarding this. Would you update the PR title or the PR description so the description is reflecting the actual change here? I think my only problem here is that the removal of rewrap is not mentioned anywhere except for the actual code change. |
|
@reyang i have made the description more verbose to explain why the rewrap setting is not needed. |
6 participants
Changes
This cleans up the vscode settings to use the markdownlint config file and recomended that users install the extension.
Also remove un-used settings which includes rewrap. Rewrap will use editor ruler settings if no dedicated setting hence no need for dedicated setting.
For non-trivial changes, follow the change proposal process.
CHANGELOG.mdfile updated for non-trivial changesspec-compliance-matrix.mdupdated if necessary